<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Docs For Class Madoqua_Search_Indexer</title>
    <link rel="stylesheet" type="text/css" href="../media/style.css" />
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  </head>
  <body>
  
    <h1>Madoqua :: Docs For Class Madoqua_Search_Indexer</h1>

    <table width="100%">
      <tr valign="top">
        <td class="menu">
                                <div class="package">
              <div id="todolist">
                <p><a href="../todolist.html">Todo List</a></p>
              </div>
            </div>
                    <h2>Packages:</h2>
          <div class="package">
            <ul>
                              <li>
                  <a href="../classtrees_default.html">default</a>
                </li>
                              <li>
                  <a href="../classtrees_Application.html">Application</a>
                </li>
                              <li>
                  <a href="../classtrees_Cache.html">Cache</a>
                </li>
                              <li>
                  <a href="../classtrees_Controller.html">Controller</a>
                </li>
                              <li>
                  <a href="../classtrees_Db.html">Db</a>
                </li>
                              <li>
                  <a href="../classtrees_Filter.html">Filter</a>
                </li>
                              <li>
                  <a href="../classtrees_Form.html">Form</a>
                </li>
                              <li>
                  <a href="../classtrees_Install.html">Install</a>
                </li>
                              <li>
                  <a href="../classtrees_Loader.html">Loader</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Exception.html">Madoqua_Exception</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Observer.html">Madoqua_Observer</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Plugin.html">Madoqua_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_View.html">Madoqua_View</a>
                </li>
                              <li>
                  <a href="../classtrees_Module.html">Module</a>
                </li>
                              <li>
                  <a href="../classtrees_Naneau_Plugin.html">Naneau_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Redirector.html">Redirector</a>
                </li>
                              <li>
                  <a href="../classtrees_Search.html">Search</a>
                </li>
                              <li>
                  <a href="../classtrees_Validate.html">Validate</a>
                </li>
                              <li>
                  <a href="../classtrees_View.html">View</a>
                </li>
                          </ul>
          </div>
                                                                    <h2>Classes:</h2>
                <ul>
		    		<li><a href="../Search/Madoqua_Search_Indexer.html">Madoqua_Search_Indexer</a></li>    	  </ul>
                              </td>
        <td>
          <table style="width:750px;" cellpadding="10" cellspacing="10px">
            <tr>
              <td valign="top">
                                                                  <h2>Search::Madoqua_Search_Indexer</h2>
                                <div class="menu">
          
                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                            [ <a href="../index.html">Index</a> ]
                      [ <a href="../classtrees_Search.html">Search classes</a> ]
            [ <a href="../elementindex_Search.html">Search elements</a> ]
                    [ <a href="../elementindex.html">All elements</a> ]
          [ <a href="../errors.html">Errors</a> ]
                </div>
<a name="sec-description"></a>
<h2>Class Madoqua_Search_Indexer</h2>

<p>Madoqua_Search_Indexer</p>		




  <strong>Author(s):</strong>
  <ul>
                </ul>

  <table>
    	  		<tr>
		  <td>
		    <strong>Todo:</strong>&nbsp;&nbsp;
		  </td>
		  <td>move to the model layer (perhaps follow the zym path? ;))</td>
		</tr>
	        </table>





  <a name="sec-var-summary"></a>
  <h2>Member Variables</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>protected</em>            static
            <em>Zend_Search_Lucene</em>          </td>
          <td>
            <code>
              $_indexer
                          </code>
            <br /><div style="margin-left: 20px">lucene indexer</div>                      </td>
        </tr>
                          </table>


  <a name="sec-method-summary"></a>
  <h2>Method Summary</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>protected</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#cleanPage"><b>cleanPage</b></a>(
                                                                                    $post
                                                 )
            </code>
            <br /><div style="margin-left: 20px">clean old post</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#cleanPost"><b>cleanPost</b></a>(
                                                                                    $post
                                                 )
            </code>
            <br /><div style="margin-left: 20px">clean old post</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#countAndClean"><b>countAndClean</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">count the number of index changes and perform an automatic clean if necessary  (and the configuration allows it)</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Search_Lucene</em>          </td>
          <td>
            <code>
              <a href="#getIndexer"><b>getIndexer</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the indexer</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#indexPage"><b>indexPage</b></a>(
                                                                                    $page
                                                 )
            </code>
            <br /><div style="margin-left: 20px">index a blog page row</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#indexPost"><b>indexPost</b></a>(
                                                                                    $post
                                                 )
            </code>
            <br /><div style="margin-left: 20px">index a blog post row</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#reset"><b>reset</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">reset the search index</div>          </td>
        </tr>
                                                                                      </table>


  <a name="sec-methods"></a>
  <h2>Methods</h2>
  <a name='method_detail'></a>
      <a name="methodcleanPage" id="cleanPage"><!-- --></a>

    <h3>cleanPage</h3>

    <div class="method-signature">
      static void
      cleanPage(
                                  
          $post
                        )
    </div>

      <p>clean old post</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$post</code></td>
                <td><em>Blog_Post_Row</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodcleanPost" id="cleanPost"><!-- --></a>

    <h3>cleanPost</h3>

    <div class="method-signature">
      static void
      cleanPost(
                                  
          $post
                        )
    </div>

      <p>clean old post</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$post</code></td>
                <td><em>Blog_Post_Row</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodcountAndClean" id="countAndClean"><!-- --></a>

    <h3>countAndClean</h3>

    <div class="method-signature">
      static void
      countAndClean(
      )
    </div>

      <p>count the number of index changes and perform an automatic clean if necessary  (and the configuration allows it)</p>      
      
      
      
      
      
        <a name="methodgetIndexer" id="getIndexer"><!-- --></a>

    <h3>getIndexer</h3>

    <div class="method-signature">
      static Zend_Search_Lucene
      getIndexer(
      )
    </div>

      <p>get the indexer</p>      
      
      
      
      
      
        <a name="methodindexPage" id="indexPage"><!-- --></a>

    <h3>indexPage</h3>

    <div class="method-signature">
      static void
      indexPage(
                                  
          $page
                        )
    </div>

      <p>index a blog page row</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$page</code></td>
                <td><em>Blog_Page_Row</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodindexPost" id="indexPost"><!-- --></a>

    <h3>indexPost</h3>

    <div class="method-signature">
      static void
      indexPost(
                                  
          $post
                        )
    </div>

      <p>index a blog post row</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$post</code></td>
                <td><em>Blog_Post_Row</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodreset" id="reset"><!-- --></a>

    <h3>reset</h3>

    <div class="method-signature">
      static void
      reset(
      )
    </div>

      <p>reset the search index</p><div><p>WILL DELETE THE ENTIRE INDEX!</p></div>      
      
      
      
      
      
  
              
<p class="notes">
  Located in <a class="field" href="_Search---Indexer.php.html">/Search/Indexer.php</a> 
  [<span class="field">line 19</span>]
</p>

                <div class="credit">
                  Documentation generated on Fri, 16 Jan 2009 10:14:42 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
                </div>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>